Public Class JSONObject

Properties Detail

• ChildCount (Get)

  Property Get ChildCount As Integer
  Number of child elements within this JsonObject.

• JSONType (Get)

  Property Get JSONType As String
  Type of the JsonObject as a string. Useful for logging. To check the JsonObject type in conditionals use the corresponding is... methods. Values are: - string - number - array - boolean - object

• Label (Get)

  Property Get Label As String
  Label for the JsonObject, blank for a JsonObject that is an array.

• ParentObject (Get)

  Property Get ParentObject As JSONObject
  JsonObject that contains this JsonObject, if available.

• ScalarValue (Get)

  Property Get ScalarValue As Variant
  String, number or boolean value of this JsonObject. Only valid for JsonObjects where isScalar is true. Not valid for arrays or objects.

• ShortValue (Get)

  Property Get ShortValue As String
  First 16 characters of the toString() value of this JsonObject. Useful for debugging or logging purposes to easly identify the current JsonObject from a larger string of JSON.

• ValueArray (Get)

  Property Get ValueArray As Variant
  Only valid for a JsonObject that contains an array of scalars. Returns a Variant array of the values.

• Label (Set)

  Property Set Label As String
  Label for the JsonObject, blank for a JsonObject that is an array.

• ScalarValue (Set)

  Property Set ScalarValue As Variant
  String, number or boolean value of this JsonObject. Only valid for JsonObjects where isScalar is true. Not valid for arrays or objects.

Methods Detail

• AppendToJSONArray

  Function AppendToJSONArray(Value As Variant) As JSONObject
  For JsonObjects that are arrays, appends a value to the array. For new JsonObjects, it appends the value to the array and defines it as an array. Returns the current JsonObject instance for fluid coding.
  idx	Argument	Data Type	Attributes	Comments
  1	Value	Variant		Value to add to the array
  Code Sample
  %REM The following code appends a string of JSON arrays into an existing JsonObject. %END REM Dim jp as new JsonParser Call jp.loadFromJson(|[]|) Dim arrayjo as JsonObject Set arrayJo = jp.getrootobject() Call arrayJo.appendToJsonArray("Hello") Call arrayJo.appendToJsonArray("New") Call arrayJo.appendToJsonArray("World") Print arrayJo.toString(false)

• FindObjectByPath

  Function FindObjectByPath(Labels As String Array) As JSONObject
  Finds a JsonObject within the current JsonObject using an array of labels to navigate down the hierarchy.
  idx	Argument	Data Type	Attributes	Comments
  1	Labels	String	Array	Array of labels to use to find the JsonObject
  Code Sample
  %REM The following example loads a string of JSON and finds the element at "address/addr1" %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String Dim path(1) as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() path(0) = "address" path(1) = "add1" Set childObj = jsonObj.findObjectByPath(path) Print childObj.toString(True)

• GetChild

  Function GetChild(Label As String) As JSONObject
  Gets a child from the current JsonObject using its label. Returns an error 404 if the child JsonObject cannot be found.
  idx	Argument	Data Type	Attributes	Comments
  1	Label	String		Label of child
  Code Sample
  %REM The following example loads a string of JSON, gets the "children" element and pretty-prints it. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.getChild("children").toString(True)

• GetChildren

  Function GetChildren() As JSONObject Array
  Gets all the children of the current JsonObject, as an array of JsonObjects. Only valid is the JsonObject is an object or an array.
  Code Sample
  %REM The following code loads a string of JSON and prints the type of all direct children. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() ForAll child in jsonObj.getChildren() Print child.jsonType End ForAll

• GetDescendantPath

  Function GetDescendantPath(Path As String, Delimiter As String) As JSONObject
  Retrieves a descendent JSONObject from another JSONObject using a specified path to the child object.
  idx	Argument	Data Type	Attributes	Comments
  1	Path	String		Delimited path to the desired item
  2	Delimiter	String	CONST, OPTIONAL, OptionalValue: LIT_STR("/")	Character used as a delimiter in Path. Defaults to "/"

• InsertObject

  Function InsertObject(Object As JSONObject, Label As String) As JSONObject
  Inserts another JsonObject into an existing JsonObject, with an optional label. If no label is provided, the label of the JsonObject is used. Returns the current JsonObject instance for fluid coding.
  idx	Argument	Data Type	Attributes	Comments
  1	Object	JSONObject		JsonObject to insert
  2	Label	String	CONST, OPTIONAL, OptionalValue: LIT_STR("")	Label to use when inserting
  Code Sample
  %REM The following code inserts a certain JsonObject into another JsonObject. %END REM Dim jo as New JsonObject Dim childJo as New JsonObject Call childJo.insertValue("boolean", true) Call jo.insertObject(childJo, "childObj") Print jo.toString(false)

• InsertValue

  Function InsertValue(Label As String, Value As Variant) As JSONObject
  Inserts a value into a JsonObject using th label defined. Returns the current JsonObject instance for fluid coding.
  idx	Argument	Data Type	Attributes	Comments
  1	Label	String		Label to insert as
  2	Value	Variant		Value to add, either a scalar or another JsonObject
  Code Sample
  %REM The following code inserts a value that corresponds to the defined label into an existing JsonObect. %END REM Dim jo as New JsonObject Dim jp as New JSONParser Dim jsonStr as String jsonStr = |{"hello":"world"}| Call jp.loadFromJSON(helloWorld) Set jo = jp.getrootobject Call jo.insertValue("John", "Doe") Print jo.toString(false)

• IsArray

  Function IsArray() As Boolean
  Returns whether or not a given JsonObject is an array.
  Code Sample
  %REM The following code loads a string of JSON and checks whether elements are arrays. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isArray() 'False Print jsonObj.getChild("children").isArray() 'True

• IsBoolean

  Function IsBoolean() As Boolean
  Returns whether or not a JsonObject is a boolean.
  Code Sample
  %REM The following code loads a string of JSON and checks whether elements are booleans. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isBoolean() ' False Print jsonObj.getChild("living").isBoolean() ' True

• IsChild

  Function IsChild(Label As String) As Boolean
  Returns whether or not the JsonObject has a child with the specified label.
  idx	Argument	Data Type	Attributes	Comments
  1	Label	String		Label within this JsonObject
  Code Sample
  %REM The following code loads a string of JSON and checks whether specific children exist. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isChild("address") ' True Print jsonObj.isChild("hobbies") ' False

• IsDescendant

  Function IsDescendant(Path As String Array) As Boolean
  Checks if there is a JsonObject within the current JsonObject, using an array of labels to navigate down the hierarchy.
  idx	Argument	Data Type	Attributes	Comments
  1	Path	String	Array	Array of labels to use to check for the JsonObject
  Code Sample
  %REM The following code loads a string of JSON and checks whether descendants exist. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String Dim path(1) as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() path(0) = "address" path(1) = "addr1" Print jsonObj.isDescendant(path) ' True path(1) = "addr3" Print jsonObj.isDescendant(path) ' False

• IsDescendantPath

  Function IsDescendantPath(Path As String, Delimiter As String) As Boolean
  idx	Argument	Data Type	Attributes	Comments
  1	Path	String
  2	Delimiter	String	CONST, OPTIONAL, OptionalValue: LIT_STR("/")

• IsNull

  Function IsNull() As Boolean
  Returns TRUE if the current JsonObject has a null value

• IsNumber

  Function IsNumber() As Boolean
  Returns whether or not a JsonObject is a number.
  Code Sample
  %REM The following code loads a string of JSON and checks whether elements are numbers. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isNumber() ' False Print jsonObj.getChild("age").isNumber() ' True

• IsObject

  Function IsObject() As Boolean
  Returns whether or not a JsonObject is an object.
  Code Sample
  %REM The following code loads a string of JSON and checks whether elements are JSON objects. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isObject() ' True Print jsonObj.getChild("living").isObject() ' False

• IsScalar

  Function IsScalar() As Boolean
  Returns whether or not a JsonObject is a scalar value (string, number, boolean).
  Code Sample
  %REM The following code loads a string of JSON and checks whether elements are scalars. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isScalar() ' False Print jsonObj.getChild("living").isScalar() ' True

• IsString

  Function IsString() As Boolean
  Returns whether or not a JsonObject is a string.
  Code Sample
  %REM The following code loads a string of JSON and checks whether elements are strings. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Print jsonObj.isString() ' False Print jsonObj.getChild("firstName").isString() ' True

• New

  Function New(IsArray As Boolean) As JSONObject
  Constructor
  idx	Argument	Data Type	Attributes	Comments
  1	IsArray	Boolean	OPTIONAL, BY_VAL, OptionalValue: LSXFalse	If IsArray is T, creates an empty array object ([]), otherwise an empty JSON object ({})

• RemoveArrayEntry

  Function RemoveArrayEntry(Index As Integer) As JSONObject
  For a JsonObject that is an array, remove the array entry at the provided index (0 being the first entry)
  idx	Argument	Data Type	Attributes	Comments
  1	Index	Integer-Unsigned	BY_VAL	The position in the array (0-based) of the entry to remove

• RemoveChild

  Function RemoveChild(Label As String) As JSONObject
  Removes a child from a JsonObject.
  idx	Argument	Data Type	Attributes	Comments
  1	Label	String		Label of the child to remove
  Code Sample
  %REM The following code removes the child using the defined label from the specified JsonObject. %END REM Dim jo as New JsonObject Dim jp as New JSONParser Dim jsonStr as String jsonStr = |{"John":"Doe","hello":"world"}}| Call jp.loadFromJSON(helloWorld) Set jo = jp.getrootobject Call jo.removeChild("John") Print jo.toString(false)

• toString

  Function toString(PrettyPrint As Boolean) As String
  Converts a JsonObject to a string, either pretty-printed or as compact JSON.
  idx	Argument	Data Type	Attributes	Comments
  1	PrettyPrint	Boolean	BY_VAL	Whether or not to pretty-print
  Code Sample
  %REM The following code loads a string of JSON and pretty-prints the address element. %END REM Dim parser as New JsonParser() Dim jsonObj as JsonObject Dim childObj as JsonObject Dim json as String Dim path(1) as String json = |{"address":{"add1":"10 Main Street","add2":"","country":"United Kingdom","county":"","postcode":"NE1 1TT","town":"London"},"age":42,"children":[{"age":12,"firstName":"Jane"},{"age":10,"firstName":"Fred"}],"firstName":"John","lastName":"Doe","living":true}| Call parser.loadFromJson(json) Set jsonObj = parser.getRootObject() Call jsonObj.getChild("address").toString(True)